Access Tokens

Using the ExamDeveloper API

The ExamDeveloper API is used to securely access live reports of data within ExamDeveloper.

The AllData Questions (/web/{projectId}/Questions/AllData) endpoint is currently capped at 2000 items per request. If the project specified by projectId contains more than 2000 questions, only the first 2000 will be retrieved. This is due to ExamDeveloper infrastructure limitations on long-running HTTP requests. This limitation will be resolved in a future release of ExamDeveloper.

Endpoints

The API is hosted under the /datagateway-service path prefix. For the purposes of this guide, the domain example.com is used in place of the actual domain of the ExamDeveloper instance to be connected to.

OData Questions

HTTP verb: GET
Endpoint: /odata/{projectId}/Questions
Description: Returns a simplified list of all questions within the project specified by the projectId parameter. Uses the OData protocol.
Use case: For retrieving minimal data about every question in the project.

AllData Questions

HTTP verb: GET
Endpoint: /web/{projectId}/Questions/AllData
Description: Returns all data for every question in the project specified by the projectId parameter.
Use case: For accessing all question data to process.

AllData Question Revisions

HTTP verb: GET
Endpoint: /web/{projectId}/Questions/AllData/{questionNumber}/Revisions
Description: Returns all data for each revision of a single question specified by the questionNumber parameter.
Use case: For inspecting the changes/revision history of a single question.

Statistics

HTTP verb: GET
Endpoint: /web/{projectId}/Statistics
Description: Returns statistics data for all items in a project specified by the projectId parameter. Includes all available analysis groups and sets.
Use case: For viewing all item statistics data in a project across all analysis groups and sets.

Item Bank

HTTP verb: GET
Endpoint: /web/{organizationGUID}/ItemBank
Description: Returns data for an item bank specified by the organizationGUID parameter.
Use case: For inspecting information specific to an item bank, including a list of all associated projects, defined languages, and configurations.

Project

HTTP verb: GET
Endpoint: /web/{projectId}/Project
Description: Returns data for a project specified by the projectId parameter.
Use case: For inspecting information specific to a project, such as the project ID, project name, review states, etc.

Quick start steps

Follow the steps below to access and copy the token. (See also: Generate and copy access tokens, Use access tokens (Web), Use access tokens (OData))

Log into ExamDeveloper via Navigator as the user who will be accessing the data.
Select the project from which the data should be extracted from.
From ExamDeveloper, go to Manage > Users > Access Token.
The Access tokens page opens in a new browser tab or window.
Click Generate new token in the upper-right corner of the page.
A success message is shown at the top of the page and the token is displayed in the Access token section.
When you are ready to use the token, click next to the token. This copies the token secret to the clipboard.
Save the token secret in a secure location. It will not be accessible once the page is left or closed.
1. The token secret is used along with the username for authentication to the API.
Copy the links in the API Links section of the page to reuse for future API requests.
You can now begin sending requests with your preferred HTTP client (examples with CURL are provided in the next section).

Endpoint samples

For the purpose of these samples, example.com is the domain where the ExamDeveloper instance is hosted. The correct domain may be found on the Access token page where the token secret was generated, under the API links section. (Refer to Step 9 in Quick start steps ↑.)

basic-auth-credentials is a placeholder for a base64-encoded string. Its decoded form is username:token-secret where username is the username of the user that owns the token secret.

token-secret is a placeholder for the token's secret. For example, if the username is jondoe and the token secret is ABCDEFG123456789 then the pair together is jondoe:ABCDEFG123456789. This pair then must be encoded to base64 for use with the basic authentication header provided with the HTTP request.

OData Endpoint Sample

CURL Request

curl -X 'GET' \
'https://example.com/datagateway-service/odata/12998/Questions' \
-H 'accept: application/json;odata.metadata=minimal;odata.streaming=true' \
-H 'Authorization: Basic basic-auth-credentials'

Example Output

{
"@odata.context": "https://example.com/datagateway-service/odata/12998/$metadata#Questions",
"value": [
{
"ItemId": 4109,
"BlueprintId": "I.A",
"BlueprintName": "Basic Level",
"OtherBlueprints": "",
"Language": "English",
"LatestRevision": 3,
"State": "Completed",
"ItemType": "Multiple Choice - One Correct",
"WrittenBy": "smith, CASAuto1",
"WrittenOn": "2025-05-19T10:20:38.58Z",
"Enemies": "",
"Assets": ""
},
{
"ItemId": 4110,
"BlueprintId": "I.A",
"BlueprintName": "Basic Level",
"OtherBlueprints": "",
"Language": "English",
"LatestRevision": 3,
"State": "Completed",
"ItemType": "Multiple Choice - One Correct",
"WrittenBy": "smith, CASAuto1",
"WrittenOn": "2025-05-19T10:22:04.593Z",
"Enemies": "",
"Assets": ""
},
{
"ItemId": 4111,
"BlueprintId": "I.A",
"BlueprintName": "Basic Level",
"OtherBlueprints": "",
"Language": "English",
"LatestRevision": 3,
"State": "Review: Default",
"ItemType": "Multiple Choice - One Correct",
"WrittenBy": "smith, CASAuto1",
"WrittenOn": "2025-05-19T10:25:27.887Z",
"Enemies": "",
"Assets": ""
}
]
}

AllData Endpoint Sample

CURL Request

curl -X 'GET' \
'https://example.com/datagateway-service/web/12998/Questions/AllData' \
-H 'accept: */*' \
-H 'Authorization: Basic basic-auth-credentials'

Example Output

[
{
"questionLockDetail": null,
"revisionInformation": null,
"userTrackingInformation": [],
"blueprints": [
{
"blueprintNodeId": 10007,
"nodePath": "I.A",
"termLanguageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"maxDepth": 2,
"externalId": "",
"blueprintDocumentId": "e9bcf0ce-09b2-4506-967b-b2e200b4264b",
"blueprintDocumentName": "SampleAuthoring",
"bluePrintTermId": "e8c4590b-1644-4505-811d-b2e200b526f4",
"term": "Basic Level",
"level": 2
}
],
"reviewers": [],
"validators": [],
"modifiedBy": 15592,
"modifiedByFullName": "CASAuto1 smith",
"dateWritten": "2025-05-19T10:20:38.58",
"number": 4109,
"languageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"type": "ExternalItem",
"templateId": "20f1c421-8c4e-46c1-94b4-792a588d5815",
"writtenBy": 15592,
"impersonatedBy": null,
"stateInfo": {
"state": "Completed",
"reviewConfigId": null,
"reviewStateName": null
},
"editableProjectId": 12998,
"title": null,
"templateData": {
"presentation": [
{
"label": "Stem",
"content": "What is the capital of the United States?"
},
{
"response_identifier": "R1",
"options": [
{
"identifier": "A",
"content": "New York City\t ",
"key": false
},
{
"identifier": "B",
"content": "Los Angeles\t ",
"key": false
},
{
"identifier": "C",
"content": "Washington D.C.\t ",
"key": true
},
{
"identifier": "D",
"content": "Chicago",
"key": false
}
]
}
],
"responses": [
{
"identifier": "R1",
"type": "choice",
"min_selection": 1,
"max_selection": 1,
"correct": [
"C"
],
"incorrect": [
"A",
"B",
"D"
],
"score": {
"maximumPossible": 1,
"incorrect": 0,
"correct": 1
}
}
]
},
"caseId": null,
"metaDataContent": [],
"references": [
{
"id": 310981,
"referenceType": "Book",
"source": 27956,
"questionComponent": "Item",
"questionComponentLabel": "",
"formattedQuestionComponent": " [Item]",
"title": "Sample Encyclopedia",
"author": "Jon Doe",
"date": "Mar 14, 1401",
"chapter": "",
"publisher": "Example Publishing",
"page": "",
"edition": "2nd",
"article": null,
"volume": null,
"issue": null,
"resourceLocation": null,
"name": null,
"equation": null
}
],
"comments": [],
"assetIds": [],
"translationGroup": 4109,
"revision": "651251",
"majorRevision": 3,
"translatedQuestions": [],
"clonedQuestions": [],
"sourceClone": null,
"enemies": [],
"dateModified": "2025-05-19T10:27:24.69",
"itembankId": "ac6a3fde-6474-479d-ba12-ade900c1bb9d",
"projects": [
12998
],
"hasAnalysisSet": false,
"itemTypeName": "Multiple Choice - One Correct",
"searchData": "What is the capital of the United States? New York City\t Los Angeles\t Washington D.C.\t Chicago",
"itemSrc": "ExD"
},
{
"questionLockDetail": null,
"revisionInformation": null,
"userTrackingInformation": [],
"blueprints": [
{
"blueprintNodeId": 10007,
"nodePath": "I.A",
"termLanguageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"maxDepth": 2,
"externalId": "",
"blueprintDocumentId": "e9bcf0ce-09b2-4506-967b-b2e200b4264b",
"blueprintDocumentName": "SampleAuthoring",
"bluePrintTermId": "e8c4590b-1644-4505-811d-b2e200b526f4",
"term": "Basic Level",
"level": 2
}
],
"reviewers": [],
"validators": [],
"modifiedBy": 15592,
"modifiedByFullName": "CASAuto1 smith",
"dateWritten": "2025-05-19T10:22:04.593",
"number": 4110,
"languageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"type": "ExternalItem",
"templateId": "20f1c421-8c4e-46c1-94b4-792a588d5815",
"writtenBy": 15592,
"impersonatedBy": null,
"stateInfo": {
"state": "Completed",
"reviewConfigId": null,
"reviewStateName": null
},
"editableProjectId": 12998,
"title": null,
"templateData": {
"presentation": [
{
"label": "Stem",
"content": "Which of these sports is considered \"America's pastime?\""
},
{
"response_identifier": "R1",
"options": [
{
"identifier": "A",
"content": "Basketball\t ",
"key": false
},
{
"identifier": "B",
"content": "American Football",
"key": false
},
{
"identifier": "C",
"content": "Baseball\t ",
"key": true
},
{
"identifier": "D",
"content": "Football (a.k.a. \"Soccer\")",
"key": false
}
]
}
],
"responses": [
{
"identifier": "R1",
"type": "choice",
"min_selection": 1,
"max_selection": 1,
"correct": [
"C"
],
"incorrect": [
"A",
"B",
"D"
],
"score": {
"maximumPossible": 1,
"incorrect": 0,
"correct": 1
}
}
]
},
"caseId": null,
"metaDataContent": [],
"references": [
{
"id": 310983,
"referenceType": "Url",
"source": 27957,
"questionComponent": "Item",
"questionComponentLabel": "",
"formattedQuestionComponent": " [Item]",
"title": null,
"author": null,
"date": "Mar 14, 1994",
"chapter": null,
"publisher": null,
"page": null,
"edition": null,
"article": null,
"volume": null,
"issue": null,
"resourceLocation": "http://example.com",
"name": null,
"equation": null
}
],
"comments": [],
"assetIds": [],
"translationGroup": 4110,
"revision": "651253",
"majorRevision": 3,
"translatedQuestions": [],
"clonedQuestions": [],
"sourceClone": null,
"enemies": [],
"dateModified": "2025-05-19T10:28:13.81",
"itembankId": "ac6a3fde-6474-479d-ba12-ade900c1bb9d",
"projects": [
12998
],
"hasAnalysisSet": false,
"itemTypeName": "Multiple Choice - One Correct",
"searchData": "Which of these sports is considered \"America's pastime?\" Basketball\t American Football Baseball\t Football (a.k.a. \"Soccer\")",
"itemSrc": "ExD"
},
{
"questionLockDetail": null,
"revisionInformation": null,
"userTrackingInformation": [],
"blueprints": [
{
"blueprintNodeId": 10007,
"nodePath": "I.A",
"termLanguageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"maxDepth": 2,
"externalId": "",
"blueprintDocumentId": "e9bcf0ce-09b2-4506-967b-b2e200b4264b",
"blueprintDocumentName": "SampleAuthoring",
"bluePrintTermId": "e8c4590b-1644-4505-811d-b2e200b526f4",
"term": "Basic Level",
"level": 2
}
],
"reviewers": [],
"validators": [],
"modifiedBy": 15592,
"modifiedByFullName": "CASAuto1 smith",
"dateWritten": "2025-05-19T10:25:27.887",
"number": 4111,
"languageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"type": "ExternalItem",
"templateId": "20f1c421-8c4e-46c1-94b4-792a588d5815",
"writtenBy": 15592,
"impersonatedBy": null,
"stateInfo": {
"state": "Review",
"reviewConfigId": "23b533b4-cca1-491e-8aef-b2e200b42628",
"reviewStateName": "Review: Default"
},
"editableProjectId": 12998,
"title": null,
"templateData": {
"presentation": [
{
"label": "Stem",
"content": "Which U.S. holiday is celebrated on the fourth Thursday of November?"
},
{
"response_identifier": "R1",
"options": [
{
"identifier": "A",
"content": "Independence Day\t ",
"key": false
},
{
"identifier": "B",
"content": "Thanksgiving\t ",
"key": true
},
{
"identifier": "C",
"content": "Memorial Day\t ",
"key": false
},
{
"identifier": "D",
"content": "Labor Day",
"key": false
}
]
}
],
"responses": [
{
"identifier": "R1",
"type": "choice",
"min_selection": 1,
"max_selection": 1,
"correct": [
"B"
],
"incorrect": [
"A",
"C",
"D"
],
"score": {
"maximumPossible": 1,
"incorrect": 0,
"correct": 1
}
}
]
},
"caseId": null,
"metaDataContent": [],
"references": [
{
"id": 310982,
"referenceType": "Journal",
"source": 27958,
"questionComponent": "Item",
"questionComponentLabel": "",
"formattedQuestionComponent": " [Item]",
"title": "The Example Journal",
"author": "John Doe",
"date": "Mar 14th, 2020",
"chapter": null,
"publisher": null,
"page": "",
"edition": null,
"article": "",
"volume": "",
"issue": "",
"resourceLocation": null,
"name": null,
"equation": null
}
],
"comments": [],
"assetIds": [],
"translationGroup": 4111,
"revision": "651252",
"majorRevision": 3,
"translatedQuestions": [],
"clonedQuestions": [],
"sourceClone": null,
"enemies": [],
"dateModified": "2025-05-19T10:27:35.963",
"itembankId": "ac6a3fde-6474-479d-ba12-ade900c1bb9d",
"projects": [
12998
],
"hasAnalysisSet": false,
"itemTypeName": "Multiple Choice - One Correct",
"searchData": "Which U.S. holiday is celebrated on the fourth Thursday of November? Independence Day\t Thanksgiving\t Memorial Day\t Labor Day",
"itemSrc": "ExD"
}
]

AllData Revisions Endpoint Sample

CURL Request

curl -X 'GET' \
'https://example.com/datagateway-service/web/12998/Questions/AllData/4110/Revisions' \
-H 'accept: */*' \
-H 'Authorization: Basic <basic-auth-credentials>'

Example Output

[
{
"questionLockDetail": null,
"revisionInformation": null,
"userTrackingInformation": [],
"blueprints": [
{
"blueprintNodeId": 10007,
"nodePath": "I.A",
"termLanguageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"maxDepth": 2,
"externalId": "",
"blueprintDocumentId": "e9bcf0ce-09b2-4506-967b-b2e200b4264b",
"blueprintDocumentName": "SampleAuthoring",
"bluePrintTermId": "e8c4590b-1644-4505-811d-b2e200b526f4",
"term": "Basic Level",
"level": 2
}
],
"reviewers": [],
"validators": [],
"modifiedBy": 15592,
"modifiedByFullName": "CASAuto1 smith",
"dateWritten": "2025-05-19T10:22:04.593",
"number": 4110,
"languageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"type": "ExternalItem",
"templateId": "20f1c421-8c4e-46c1-94b4-792a588d5815",
"writtenBy": 15592,
"impersonatedBy": null,
"stateInfo": {
"state": "Completed",
"reviewConfigId": null,
"reviewStateName": null
},
"editableProjectId": 12998,
"title": null,
"templateData": {
"presentation": [
{
"label": "Stem",
"content": "Which of these sports is considered \"America's pastime?\""
},
{
"response_identifier": "R1",
"options": [
{
"identifier": "A",
"content": "Basketball\t ",
"key": false
},
{
"identifier": "B",
"content": "American Football",
"key": false
},
{
"identifier": "C",
"content": "Baseball\t ",
"key": true
},
{
"identifier": "D",
"content": "Football (a.k.a. \"Soccer\")",
"key": false
}
]
}
],
"responses": [
{
"identifier": "R1",
"type": "choice",
"min_selection": 1,
"max_selection": 1,
"correct": [
"C"
],
"incorrect": [
"A",
"B",
"D"
],
"score": {
"maximumPossible": 1,
"incorrect": 0,
"correct": 1
}
}
]
},
"caseId": null,
"metaDataContent": [],
"references": [
{
"id": 310983,
"referenceType": "Url",
"source": 27957,
"questionComponent": "Item",
"questionComponentLabel": "",
"formattedQuestionComponent": " [Item]",
"title": null,
"author": null,
"date": "Mar 14, 1994",
"chapter": null,
"publisher": null,
"page": null,
"edition": null,
"article": null,
"volume": null,
"issue": null,
"resourceLocation": "http://example.com",
"name": null,
"equation": null
}
],
"comments": [],
"assetIds": [],
"translationGroup": 4110,
"revision": "651253",
"latestRevisionNumber": 3,
"majorRevision": 3,
"translatedQuestions": [],
"clonedQuestions": [],
"sourceClone": null,
"enemies": [],
"dateModified": "2025-05-19T10:28:13.81",
"itembankId": "ac6a3fde-6474-479d-ba12-ade900c1bb9d",
"projects": [
12998
],
"hasAnalysisSet": false,
"itemTypeName": "Multiple Choice - One Correct",
"searchData": "Which of these sports is considered \"America's pastime?\" Basketball\t American Football Baseball\t Football (a.k.a. \"Soccer\")",
"itemSrc": "ExD"
},
{
"questionLockDetail": null,
"revisionInformation": null,
"userTrackingInformation": [],
"blueprints": [
{
"blueprintNodeId": 10007,
"nodePath": "I.A",
"termLanguageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"maxDepth": 2,
"externalId": "",
"blueprintDocumentId": "e9bcf0ce-09b2-4506-967b-b2e200b4264b",
"blueprintDocumentName": "SampleAuthoring",
"bluePrintTermId": "e8c4590b-1644-4505-811d-b2e200b526f4",
"term": "Basic Level",
"level": 2
}
],
"reviewers": [],
"validators": [],
"modifiedBy": 15592,
"modifiedByFullName": "CASAuto1 smith",
"dateWritten": "2025-05-19T10:22:04.593",
"number": 4110,
"languageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"type": "ExternalItem",
"templateId": "20f1c421-8c4e-46c1-94b4-792a588d5815",
"writtenBy": 15592,
"impersonatedBy": null,
"stateInfo": {
"state": "Completed",
"reviewConfigId": null,
"reviewStateName": null
},
"editableProjectId": 12998,
"title": null,
"templateData": {
"presentation": [
{
"label": "Stem",
"content": "Which of these sports is considered \"America's pastime?\""
},
{
"response_identifier": "R1",
"options": [
{
"identifier": "A",
"content": "Basketball\t ",
"key": false
},
{
"identifier": "B",
"content": "Football\t ",
"key": false
},
{
"identifier": "C",
"content": "Baseball\t ",
"key": true
},
{
"identifier": "D",
"content": "Soccer",
"key": false
}
]
}
],
"responses": [
{
"identifier": "R1",
"type": "choice",
"min_selection": 1,
"max_selection": 1,
"correct": [
"C"
],
"incorrect": [
"A",
"B",
"D"
],
"score": {
"maximumPossible": 1,
"incorrect": 0,
"correct": 1
}
}
]
},
"caseId": null,
"metaDataContent": [],
"references": [
{
"id": 310978,
"referenceType": "Url",
"source": 27957,
"questionComponent": "Item",
"questionComponentLabel": "",
"formattedQuestionComponent": " [Item]",
"title": null,
"author": null,
"date": "Mar 14, 1994",
"chapter": null,
"publisher": null,
"page": null,
"edition": null,
"article": null,
"volume": null,
"issue": null,
"resourceLocation": "http://example.com",
"name": null,
"equation": null
}
],
"comments": [],
"assetIds": [],
"translationGroup": 4110,
"revision": "651248",
"latestRevisionNumber": 3,
"majorRevision": 2,
"translatedQuestions": [],
"clonedQuestions": [],
"sourceClone": null,
"enemies": [],
"dateModified": "2025-05-19T10:22:05.4",
"itembankId": "ac6a3fde-6474-479d-ba12-ade900c1bb9d",
"projects": [
12998
],
"hasAnalysisSet": false,
"itemTypeName": "Multiple Choice - One Correct",
"searchData": "Which of these sports is considered \"America's pastime?\" Basketball\t American Football Baseball\t Football (a.k.a. \"Soccer\")",
"itemSrc": "ExD"
},
{
"questionLockDetail": null,
"revisionInformation": null,
"userTrackingInformation": [],
"blueprints": [
{
"blueprintNodeId": 10007,
"nodePath": "I.A",
"termLanguageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"maxDepth": 2,
"externalId": "",
"blueprintDocumentId": "e9bcf0ce-09b2-4506-967b-b2e200b4264b",
"blueprintDocumentName": "SampleAuthoring",
"bluePrintTermId": "e8c4590b-1644-4505-811d-b2e200b526f4",
"term": "Basic Level",
"level": 2
}
],
"reviewers": [],
"validators": [],
"modifiedBy": 15592,
"modifiedByFullName": "CASAuto1 smith",
"dateWritten": "2025-05-19T10:22:04.593",
"number": 4110,
"languageCode": "ce9d09b5-b149-4d04-9985-ade900c1bfd8",
"type": "ExternalItem",
"templateId": "20f1c421-8c4e-46c1-94b4-792a588d5815",
"writtenBy": 15592,
"impersonatedBy": null,
"stateInfo": {
"state": "Draft",
"reviewConfigId": null,
"reviewStateName": null
},
"editableProjectId": 12998,
"title": null,
"templateData": {
"presentation": [
{
"label": "Stem",
"content": "Which of these sports is considered \"America's pastime?\""
},
{
"response_identifier": "R1",
"options": [
{
"identifier": "A",
"content": "Basketball\t ",
"key": false
},
{
"identifier": "B",
"content": "Football\t ",
"key": false
},
{
"identifier": "C",
"content": "Baseball\t ",
"key": true
},
{
"identifier": "D",
"content": "Soccer",
"key": false
}
]
}
],
"responses": [
{
"identifier": "R1",
"type": "choice",
"min_selection": 1,
"max_selection": 1,
"correct": [
"C"
],
"incorrect": [
"A",
"B",
"D"
],
"score": {
"maximumPossible": 1,
"incorrect": 0,
"correct": 1
}
}
]
},
"caseId": null,
"metaDataContent": [],
"references": [
{
"id": 310977,
"referenceType": "Url",
"source": 27957,
"questionComponent": "Item",
"questionComponentLabel": "",
"formattedQuestionComponent": " [Item]",
"title": null,
"author": null,
"date": "Mar 14, 1994",
"chapter": null,
"publisher": null,
"page": null,
"edition": null,
"article": null,
"volume": null,
"issue": null,
"resourceLocation": "http://example.com",
"name": null,
"equation": null
}
],
"comments": [],
"assetIds": [],
"translationGroup": 4110,
"revision": "651247",
"latestRevisionNumber": 3,
"majorRevision": 1,
"translatedQuestions": [],
"clonedQuestions": [],
"sourceClone": null,
"enemies": [],
"dateModified": "2025-05-19T10:22:04.593",
"itembankId": "ac6a3fde-6474-479d-ba12-ade900c1bb9d",
"projects": [
12998
],
"hasAnalysisSet": false,
"itemTypeName": "Multiple Choice - One Correct",
"searchData": "Which of these sports is considered \"America's pastime?\" Basketball\t American Football Baseball\t Football (a.k.a. \"Soccer\")",
"itemSrc": "ExD"
}
]